<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>CGSGTimeline - SceneGraph.js</title>
    <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
    <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
    <link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
    <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">

<div id="doc">
    <div id="hd" class="yui3-g header">
        <div class="yui3-u-3-4">
            
                <h1><img src="../../logo/logoCGSG_256x57.png" title="SceneGraph.js"></h1>
            
        </div>
        <div class="yui3-u-1-4 version">
            <em>API Docs for: 2.2.0</em>
        </div>
    </div>
    <div id="bd" class="yui3-g">

        <div class="yui3-u-1-4">
            <div id="docs-sidebar" class="sidebar apidocs">
                <div id="api-list">
    <h2 class="off-left">APIs</h2>
    <div id="api-tabview" class="tabview">
        <ul class="tabs">
            <li><a href="#api-classes">Classes</a></li>
            <li><a href="#api-modules">Modules</a></li>
        </ul>

        <div id="api-tabview-filter">
            <input type="search" id="api-filter" placeholder="Type to filter APIs">
        </div>

        <div id="api-tabview-panel">
            <ul id="api-classes" class="apis classes">
            
                <li><a href="../classes/CGSG.html">CGSG</a></li>
            
                <li><a href="../classes/CGSGAccordion.html">CGSGAccordion</a></li>
            
                <li><a href="../classes/CGSGAnimationManager.html">CGSGAnimationManager</a></li>
            
                <li><a href="../classes/CGSGAnimationMethod.html">CGSGAnimationMethod</a></li>
            
                <li><a href="../classes/CGSGBindEntry.html">CGSGBindEntry</a></li>
            
                <li><a href="../classes/CGSGButtonMode.html">CGSGButtonMode</a></li>
            
                <li><a href="../classes/CGSGCollisionGhostOnDemandTester.html">CGSGCollisionGhostOnDemandTester</a></li>
            
                <li><a href="../classes/CGSGCollisionManager.html">CGSGCollisionManager</a></li>
            
                <li><a href="../classes/CGSGCollisionMethod.html">CGSGCollisionMethod</a></li>
            
                <li><a href="../classes/CGSGCollisionRegionTester.html">CGSGCollisionRegionTester</a></li>
            
                <li><a href="../classes/CGSGCollisionTesterFactory.html">CGSGCollisionTesterFactory</a></li>
            
                <li><a href="../classes/CGSGColor.html">CGSGColor</a></li>
            
                <li><a href="../classes/CGSGCSSManager.html">CGSGCSSManager</a></li>
            
                <li><a href="../classes/CGSGDimension.html">CGSGDimension</a></li>
            
                <li><a href="../classes/CGSGEvent.html">CGSGEvent</a></li>
            
                <li><a href="../classes/CGSGEventManager.html">CGSGEventManager</a></li>
            
                <li><a href="../classes/CGSGHandleBox.html">CGSGHandleBox</a></li>
            
                <li><a href="../classes/CGSGImgManager.html">CGSGImgManager</a></li>
            
                <li><a href="../classes/CGSGInterpolator.html">CGSGInterpolator</a></li>
            
                <li><a href="../classes/CGSGInterpolatorLinear.html">CGSGInterpolatorLinear</a></li>
            
                <li><a href="../classes/CGSGInterpolatorTCB.html">CGSGInterpolatorTCB</a></li>
            
                <li><a href="../classes/CGSGKeyFrame.html">CGSGKeyFrame</a></li>
            
                <li><a href="../classes/CGSGMap.html">CGSGMap</a></li>
            
                <li><a href="../classes/CGSGMask.html">CGSGMask</a></li>
            
                <li><a href="../classes/CGSGMaskCache.html">CGSGMaskCache</a></li>
            
                <li><a href="../classes/CGSGMaskClip.html">CGSGMaskClip</a></li>
            
                <li><a href="../classes/CGSGMath.html">CGSGMath</a></li>
            
                <li><a href="../classes/CGSGNode.html">CGSGNode</a></li>
            
                <li><a href="../classes/CGSGNodeButton.html">CGSGNodeButton</a></li>
            
                <li><a href="../classes/CGSGNodeCircle.html">CGSGNodeCircle</a></li>
            
                <li><a href="../classes/CGSGNodeColorPicker.html">CGSGNodeColorPicker</a></li>
            
                <li><a href="../classes/CGSGNodeCurveTCB.html">CGSGNodeCurveTCB</a></li>
            
                <li><a href="../classes/CGSGNodeDomElement.html">CGSGNodeDomElement</a></li>
            
                <li><a href="../classes/CGSGNodeEllipse.html">CGSGNodeEllipse</a></li>
            
                <li><a href="../classes/CGSGNodeImage.html">CGSGNodeImage</a></li>
            
                <li><a href="../classes/CGSGNodeLine.html">CGSGNodeLine</a></li>
            
                <li><a href="../classes/CGSGNodeSlider.html">CGSGNodeSlider</a></li>
            
                <li><a href="../classes/CGSGNodeSliderHandle.html">CGSGNodeSliderHandle</a></li>
            
                <li><a href="../classes/CGSGNodeSprite.html">CGSGNodeSprite</a></li>
            
                <li><a href="../classes/CGSGNodeSquare.html">CGSGNodeSquare</a></li>
            
                <li><a href="../classes/CGSGNodeTabMenu.html">CGSGNodeTabMenu</a></li>
            
                <li><a href="../classes/CGSGNodeText.html">CGSGNodeText</a></li>
            
                <li><a href="../classes/CGSGNodeWebview.html">CGSGNodeWebview</a></li>
            
                <li><a href="../classes/CGSGParticle.html">CGSGParticle</a></li>
            
                <li><a href="../classes/CGSGParticleEmitter.html">CGSGParticleEmitter</a></li>
            
                <li><a href="../classes/CGSGParticleSystem.html">CGSGParticleSystem</a></li>
            
                <li><a href="../classes/CGSGPickNodeMethod.html">CGSGPickNodeMethod</a></li>
            
                <li><a href="../classes/CGSGPosition.html">CGSGPosition</a></li>
            
                <li><a href="../classes/CGSGRegion.html">CGSGRegion</a></li>
            
                <li><a href="../classes/CGSGRotation.html">CGSGRotation</a></li>
            
                <li><a href="../classes/CGSGScale.html">CGSGScale</a></li>
            
                <li><a href="../classes/CGSGSceneGraph.html">CGSGSceneGraph</a></li>
            
                <li><a href="../classes/CGSGSection.html">CGSGSection</a></li>
            
                <li><a href="../classes/CGSGTimeline.html">CGSGTimeline</a></li>
            
                <li><a href="../classes/CGSGTraverser.html">CGSGTraverser</a></li>
            
                <li><a href="../classes/CGSGVector2D.html">CGSGVector2D</a></li>
            
                <li><a href="../classes/CGSGView.html">CGSGView</a></li>
            
                <li><a href="../classes/CGSGWEBVIEWMODE.html">CGSGWEBVIEWMODE</a></li>
            
                <li><a href="../classes/CGSGWrapMode.html">CGSGWrapMode</a></li>
            
                <li><a href="../classes/GLOBAL_CONSTANTS.html">GLOBAL_CONSTANTS</a></li>
            
                <li><a href="../classes/GLOBAL_METHODS.html">GLOBAL_METHODS</a></li>
            
                <li><a href="../classes/GLOBAL_PROPERTIES.html">GLOBAL_PROPERTIES</a></li>
            
                <li><a href="../classes/UTIL_ARRAY.html">UTIL_ARRAY</a></li>
            
                <li><a href="../classes/WUICCGSGNodeImageFactory.html">WUICCGSGNodeImageFactory</a></li>
            
            </ul>

            <ul id="api-modules" class="apis modules">
            
                <li><a href="../modules/Animation.html">Animation</a></li>
            
                <li><a href="../modules/Collision.html">Collision</a></li>
            
                <li><a href="../modules/Math.html">Math</a></li>
            
                <li><a href="../modules/Node.html">Node</a></li>
            
                <li><a href="../modules/ParticleSystem.html">ParticleSystem</a></li>
            
                <li><a href="../modules/Scene.html">Scene</a></li>
            
                <li><a href="../modules/Util.html">Util</a></li>
            
            </ul>
        </div>
    </div>
</div>

            </div>
        </div>
        <div class="yui3-u-3-4">
                <div id="api-options">
        Show:
        <label for="api-show-inherited">
            <input type="checkbox" id="api-show-inherited" checked>
            Inherited
        </label>

        <label for="api-show-protected">
            <input type="checkbox" id="api-show-protected">
            Protected
        </label>

        <label for="api-show-private">
            <input type="checkbox" id="api-show-private">
            Private
        </label>
        <label for="api-show-deprecated">
            <input type="checkbox" id="api-show-deprecated">
            Deprecated
        </label>

    </div>


            <div class="apidocs">
                <div id="docs-main">
                    <div class="content">
                        <h1>CGSGTimeline Class</h1>
<div class="box meta">
    

    

    
        <div class="foundat">
            Defined in: <a href="../files/src_animation_class.anim.timeline.js.html#l31"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:31</code></a>
        </div>
    

    
        
            Module: <a href="../modules/Animation.html">Animation</a>
        
    

    
</div>



<div class="box intro">
    
</div>



<div id="classdocs" class="tabview">
    <ul class="api-class-tabs">
        <li class="api-class-tab index"><a href="#index">Index</a></li>

        
            <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
        
        
            <li class="api-class-tab properties"><a href="#properties">Properties</a></li>
        
        
        
    </ul>

    <div>
        <div id="index" class="api-class-tabpanel index">
            <h2 class="off-left">Item Index</h2>

            
                <div class="index-section methods">
                    <h3>Methods</h3>

                    <ul class="index-list methods">
                        
                            <li class="index-item method private">
                                <a href="#method__computeNumberOfFrameBetweenKeys">_computeNumberOfFrameBetweenKeys</a>

                                
                                
                            </li>
                        
                            <li class="index-item method public">
                                <a href="#method_addKey">addKey</a>

                                
                                
                            </li>
                        
                            <li class="index-item method public">
                                <a href="#method_compute">compute</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_exportValues">exportValues</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getFirstKey">getFirstKey</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getLastKey">getLastKey</a>

                                
                                
                            </li>
                        
                            <li class="index-item method public">
                                <a href="#method_getNbKeys">getNbKeys</a>

                                
                                
                            </li>
                        
                            <li class="index-item method public">
                                <a href="#method_getValue">getValue</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_importValues">importValues</a>

                                
                                
                            </li>
                        
                            <li class="index-item method public">
                                <a href="#method_removeAll">removeAll</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_removeKey">removeKey</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_removeKeysBetween">removeKeysBetween</a>

                                
                                
                            </li>
                        
                            <li class="index-item method public">
                                <a href="#method_sortByFrame">sortByFrame</a>

                                
                                
                            </li>
                        
                    </ul>
                </div>
            

            
                <div class="index-section properties">
                    <h3>Properties</h3>

                    <ul class="index-list properties">
                        
                            <li class="index-item property private">
                                <a href="#property__method">_method</a>

                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_attribute">attribute</a>

                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_listValues">listValues</a>

                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_onAnimate">onAnimate</a>

                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_onAnimationEnd">onAnimationEnd</a>

                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_onAnimationStart">onAnimationStart</a>

                                
                                
                            </li>
                        
                            <li class="index-item property">
                                <a href="#property_parentNode">parentNode</a>

                                
                                
                            </li>
                        
                    </ul>
                </div>
            

            

            
        </div>

        
            <div id="methods" class="api-class-tabpanel">
                <h2 class="off-left">Methods</h2>

                
                    <div id="method__computeNumberOfFrameBetweenKeys" class="method item private">
    <h3 class="name"><code>_computeNumberOfFrameBetweenKeys</code></h3>

    
        <span class="paren">()</span>
    

    

    

    
        <span class="flag private">private</span>
    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l193"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:193</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Compute the number of steps between all keys, 2 by 2</p>

    </div>

    

    

    
</div>

                
                    <div id="method_addKey" class="method item public">
    <h3 class="name"><code>addKey</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>frame.</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>value</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    
        <span class="flag public">public</span>
    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l106"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:106</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Add a new animation key frame to the timeline and sort the timeline by frame number</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">frame.</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>Must be an integer value.</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">value</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_compute" class="method item public">
    <h3 class="name"><code>compute</code></h3>

    
        <span class="paren">()</span>
    

    

    

    
        <span class="flag public">public</span>
    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l227"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:227</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Compute all the values (steps) for the animation of this timeline</p>

    </div>

    

    

    
</div>

                
                    <div id="method_exportValues" class="method item">
    <h3 class="name"><code>exportValues</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l309"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:309</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Return the precomputed array of values for this timeline</p>

    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:
                    
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getFirstKey" class="method item">
    <h3 class="name"><code>getFirstKey</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="../classes/CGSGKeyFrame.html" class="crosslink">CGSGKeyFrame</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l243"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:243</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="../classes/CGSGKeyFrame.html" class="crosslink">CGSGKeyFrame</a></span>:
                    
                    <p>the first key frame of this timeline</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getLastKey" class="method item">
    <h3 class="name"><code>getLastKey</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="../classes/CGSGKeyFrame.html" class="crosslink">CGSGKeyFrame</a></span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l255"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:255</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="../classes/CGSGKeyFrame.html" class="crosslink">CGSGKeyFrame</a></span>:
                    
                    <p>the last key frame of this timeline</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getNbKeys" class="method item public">
    <h3 class="name"><code>getNbKeys</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
        </span>
    

    

    
        <span class="flag public">public</span>
    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l207"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:207</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>:
                    
                    <p>the number of keys in this timeline. Must be an integer value.</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getValue" class="method item public">
    <h3 class="name"><code>getValue</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>frame</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type"></span>
        </span>
    

    

    
        <span class="flag public">public</span>
    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l267"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:267</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Get the value for the frame number passed in parameter</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">frame</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>the frame bound with the returned value. Must be an integer value.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type"></span>:
                    
                    <p>Object with 2 properties : frame and value, or undefined
If no key is defined, return undefined
If there is only one key, returns it&#39;s value
If the frame is before the first key, returns the first key value
If the frame is after the last key, returns the last key value</p>

                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_importValues" class="method item">
    <h3 class="name"><code>importValues</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>newValues</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>startFrame</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l326"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:326</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Import new precomputed values for this timeline.
The number of values must match the number of frame defined by the keys of this timeline</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">newValues</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
                    

                    

                    <div class="param-description">
                        <p>of new values</p>

                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">startFrame</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>Must be an integer value.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_removeAll" class="method item public">
    <h3 class="name"><code>removeAll</code></h3>

    
        <span class="paren">()</span>
    

    

    

    
        <span class="flag public">public</span>
    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l181"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:181</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Remove all keys and values</p>

    </div>

    

    

    
</div>

                
                    <div id="method_removeKey" class="method item">
    <h3 class="name"><code>removeKey</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>frame</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l123"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:123</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Remove the key at the specified frame</p>

    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">frame</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                        <p>Must be an integer value.</p>

                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_removeKeysBetween" class="method item">
    <h3 class="name"><code>removeKeysBetween</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>frame1</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>frame2</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l138"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:138</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">frame1</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">frame2</code>
                        <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
                    <div id="method_sortByFrame" class="method item public">
    <h3 class="name"><code>sortByFrame</code></h3>

    
        <span class="paren">()</span>
    

    

    

    
        <span class="flag public">public</span>
    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l216"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:216</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Sort the list of keys by frame number</p>

    </div>

    

    

    
</div>

                
            </div>
        

        
            <div id="properties" class="api-class-tabpanel">
                <h2 class="off-left">Properties</h2>

                
                    <div id="property__method" class="property item private">
    <h3 class="name"><code>_method</code></h3>
    <span class="type"><a href="../classes/CGSGInterpolator.html" class="crosslink">CGSGInterpolator</a></span>

    

    
        <span class="flag private">private</span>
    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l61"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:61</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        
    </div>

    
        <p><strong>Default:</strong> {CGSGInterpolatorLinear} CGSGAnimationMethod.LINEAR</p>
    

    

    
</div>

                
                    <div id="property_attribute" class="property item">
    <h3 class="name"><code>attribute</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l53"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:53</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>A string representing the attribute to be animated (eg: &quot;position.x&quot;, &quot;rotation.angle&quot;, &quot;color.g&quot;, ...)
The attribute must be a numeric property</p>

    </div>

    

    

    
</div>

                
                    <div id="property_listValues" class="property item">
    <h3 class="name"><code>listValues</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l69"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:69</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>list of the [frame, value] pairs for the animation
the index of the list begins at 0, not at the first key frame</p>

    </div>

    

    

    
</div>

                
                    <div id="property_onAnimate" class="property item">
    <h3 class="name"><code>onAnimate</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l98"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:98</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Callback on animation event</p>

    </div>

    

    

    
</div>

                
                    <div id="property_onAnimationEnd" class="property item">
    <h3 class="name"><code>onAnimationEnd</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l92"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:92</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Callback on animation end event</p>

    </div>

    

    

    
</div>

                
                    <div id="property_onAnimationStart" class="property item">
    <h3 class="name"><code>onAnimationStart</code></h3>
    <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l86"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:86</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>Callback on animation start event</p>

    </div>

    

    

    
</div>

                
                    <div id="property_parentNode" class="property item">
    <h3 class="name"><code>parentNode</code></h3>
    <span class="type"><a href="../classes/CGSGNode.html" class="crosslink">CGSGNode</a></span>

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="../files/src_animation_class.anim.timeline.js.html#l46"><code>src&#x2F;animation&#x2F;class.anim.timeline.js:46</code></a>
        
        </p>

        

        
    </div>

    <div class="description">
        <p>The animated nodes</p>

    </div>

    

    

    
</div>

                
            </div>
        

        

        
    </div>
</div>

                    </div>
                </div>
            </div>
        </div>
    </div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>
